/*
 * ------------------------------------------------------------------------
 *
 *  Copyright by KNIME AG, Zurich, Switzerland
 *  Website: http://www.knime.com; Email: contact@knime.com
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME AG herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME.  The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * ---------------------------------------------------------------------
 *
 * History
 *   Apr 15, 2021 (Mark Ortmann, KNIME GmbH, Berlin, Germany): created
 */
package org.knime.filehandling.utility.nodes.truncator.impl;

import java.nio.file.Path;

import org.knime.filehandling.core.defaultnodesettings.filtermode.SettingsModelFilterMode.FilterMode;

/**
 * This truncator allows to remove a provided prefix from the path to truncate. The prefix has to specify a folder and
 * in case it does not match the original path is being returned.
 *
 * @author Mark Ortmann, KNIME GmbH, Berlin, Germany
 */
public final class FolderPrefixPathTruncator extends AbstractPathTruncator {

    private final Path m_baseFolder;

    private final Path m_prefixPath;

    /**
     * Constructor.
     *
     * @param basePath the base path
     * @param folderPrefix the folder prefix to be removed
     * @param filterMode the {@link FilterMode}
     */
    public FolderPrefixPathTruncator(final Path basePath, final String folderPrefix, final FilterMode filterMode) {
        if (filterMode == FilterMode.FILE) {
            m_baseFolder = basePath.getParent();
        } else {
            m_baseFolder = basePath;
        }
        m_prefixPath = getPrefixPath(m_baseFolder, folderPrefix);
    }

    @SuppressWarnings("resource")
    private static Path getPrefixPath(final Path folder, final String folderPrefix) {
        final Path prefixPath = folder.getFileSystem().getPath(folderPrefix);
        if (folder.startsWith(prefixPath)) {
            return prefixPath;
        } else {
            return null;
        }
    }

    @Override
    protected Path truncate(final Path path) {
        if (m_prefixPath != null) {
            return m_prefixPath.relativize(path).normalize();
        } else {
            return path.normalize();
        }
    }

}
